<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta name="generator" content="PHPDoctor 2RC2 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Tue, 09 Dec 2008 09:11:43 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">

<title>Contentbox (Moriarty)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>Moriarty</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../moriarty/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../moriarty/package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../moriarty/contentbox.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">Moriarty.Contentbox</div>

<h1>Class Contentbox</h1>

<pre class="tree"><strong>Contentbox</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>Contentbox</strong></p>

<div class="comment" id="overview_description"><p>
Represents a store's contentbox</p></div>

<dl>
<dt>See Also:</dt>
<dd><a href="http://n2.talis.com/wiki/Contentbox">http://n2.talis.com/wiki/Contentbox</a></dd>
</dl>
<hr>

<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Contentbox()">Contentbox</a>(string uri, <a href="../moriarty/credentials.html">Credentials</a> credentials)</p><p class="description">
Create a new instance of this class</p></td>
</tr>
</table>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">protected  void</td>
<td class="description"><p class="name"><a href="#make_search_uri()">make_search_uri</a>(mixed query, mixed max, mixed offset, mixed sort)</p></td>
</tr>
<tr>
<td class="type"> <a href="../moriarty/resourcelist.html">ResourceList</a></td>
<td class="description"><p class="name"><a href="#parse_results_xml()">parse_results_xml</a>(string uri, string xml)</p><p class="description">
Parse the results of a search on the contentbox.</p></td>
</tr>
<tr>
<td class="type"> <a href="../moriarty/httpresponse.html">HttpResponse</a></td>
<td class="description"><p class="name"><a href="#search()">search</a>(string query, int max, int offset, string sort)</p><p class="description">
Perform a search on the contentbox</p></td>
</tr>
<tr>
<td class="type"> <a href="../moriarty/resourcelist.html">ResourceList</a></td>
<td class="description"><p class="name"><a href="#search_to_resource_list()">search_to_resource_list</a>(string query, int max, int offset)</p><p class="description">
Perform a search on the contentbox. </p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#search_to_triple_list()">search_to_triple_list</a>(mixed query, mixed max, mixed offset)</p><p class="description">
Perform a search on the contentbox</p></td>
</tr>
</table>

<h2 id="detail_constr">Constructor Detail</h2>
<h3 id="Contentbox()">Contentbox</h3>
<code class="signature">public <strong>Contentbox</strong>(string uri, <a href="../moriarty/credentials.html">Credentials</a> credentials)</code>
<div class="details">
<p>
Create a new instance of this class</p><dl>
<dt>Parameters:</dt>
<dd>uri - URI of the contentbox</dd>
<dd>credentials - the credentials to use for authenticated requests (optional)</dd>
</dl>
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<h3 id="make_search_uri()">make_search_uri</h3>
<code class="signature">protected  void <strong>make_search_uri</strong>(mixed query, mixed max, mixed offset, mixed sort)</code>
<div class="details">
</div>

<hr>

<h3 id="parse_results_xml()">parse_results_xml</h3>
<code class="signature">public  <a href="../moriarty/resourcelist.html">ResourceList</a> <strong>parse_results_xml</strong>(string uri, string xml)</code>
<div class="details">
<p>
Parse the results of a search on the contentbox.</p><dl>
<dt>Parameters:</dt>
<dd>uri - the URI used to obtain the search</dd>
<dd>xml - the xml returned from a search request</dd>
</dl>
</div>

<hr>

<h3 id="search()">search</h3>
<code class="signature">public  <a href="../moriarty/httpresponse.html">HttpResponse</a> <strong>search</strong>(string query, int max, int offset, string sort)</code>
<div class="details">
<p>
Perform a search on the contentbox</p><dl>
<dt>Parameters:</dt>
<dd>query - the query expression used to query the content box.</dd>
<dd>max - maximum number of results for a search. (optional, defaults to 10)</dd>
<dd>offset - an offset into search results. Use with max to implement paging. (optional, defaults to 0)</dd>
<dd>sort - a comma separated list of field names that should be used to order the results.</dd>
</dl>
</div>

<hr>

<h3 id="search_to_resource_list()">search_to_resource_list</h3>
<code class="signature">public  <a href="../moriarty/resourcelist.html">ResourceList</a> <strong>search_to_resource_list</strong>(string query, int max, int offset)</code>
<div class="details">
<p>
Perform a search on the contentbox. This method returns an empty ResourceList if the HTTP request fails for any reason.</p><dl>
<dt>Parameters:</dt>
<dd>query - the query expression used to query the content box.</dd>
<dd>max - maximum number of results for a search. (optional, defaults to 10)</dd>
<dd>offset - an offset into search results. Use with max to implement paging. (optional, defaults to 0)</dd>
</dl>
</div>

<hr>

<h3 id="search_to_triple_list()">search_to_triple_list</h3>
<code class="signature">public  void <strong>search_to_triple_list</strong>(mixed query, mixed max, mixed offset)</code>
<div class="details">
<p>
Perform a search on the contentbox</p><dl>
<dt>Deprecated:</dt>
<dd>triple lists are deprecated</dd>
</dl>
</div>

<hr>

<div class="header">
<h1>Moriarty</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../moriarty/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../moriarty/package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../moriarty/contentbox.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://phpdoctor.sourceforge.net/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>